ninab222.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef NINAB222_H
#define NINAB222_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"




#define NINAB222_CMD_AT                    "AT"

#define NINAB222_CMD_CGMI                  "CGMI"
#define NINAB222_CMD_CGMM                  "CGMM"
#define NINAB222_CMD_CGMR                  "CGMR"
#define NINAB222_CMD_CGSN                  "CGSN"
#define NINAB222_CMD_GMI                   "GMI"
#define NINAB222_CMD_GMM                   "GMM"
#define NINAB222_CMD_GMR                   "GMR"
#define NINAB222_CMD_GSN                   "GSN"
#define NINAB222_CMD_ATI                   "ATI"
#define NINAB222_CMD_CSGT                  "CSGT"

#define NINAB222_CMD_ATW                   "W"
#define NINAB222_CMD_ATZ                   "ATZ"
#define NINAB222_CMD_ATE                   "ATE"
#define NINAB222_CMD_UFACTORY              "UFACTORY"
#define NINAB222_CMD_ATD                   "D"
#define NINAB222_CMD_ATS                   "S"
#define NINAB222_CMD_CPWROFF               "CPWROFF"
#define NINAB222_CMD_UFWUPD                "UFWUPD"
#define NINAB222_CMD_UMLA                  "UMLA"
#define NINAB222_CMD_UMLPO                 "UMLPO"
#define NINAB222_CMD_UMRS                  "UMRS"
#define NINAB222_CMD_UMRSCFG               "UMRSCFG"
#define NINAB222_CMD_UMRSIG                "UMRSIG"
#define NINAB222_CMD_UMSM                  "UMSM"
#define NINAB222_CMD_UMSTAT                "UMSTAT"
#define NINAB222_CMD_UPWRMNG               "UPWRMNG"
#define NINAB222_CMD_UPWRREG               "UPWRREG"
#define NINAB222_CMD_USTOP                 "USTOP"

#define NINAB222_CMD_ATO                   "ATO"
#define NINAB222_CMD_UDATR                 "UDATR"
#define NINAB222_CMD_UDATW                 "UDATW"
#define NINAB222_CMD_UDBIND                "UDBIND"
#define NINAB222_CMD_UDBINDC               "UDBINDC"
#define NINAB222_CMD_UDCFG                 "UDCFG"
#define NINAB222_CMD_UDCP                  "UDCP"
#define NINAB222_CMD_UDCPC                 "UDCPC"
#define NINAB222_CMD_UDDRP                 "UDDRP"
#define NINAB222_CMD_UDLP                  "UDLP"
#define NINAB222_CMD_UDSC                  "UDSC"
#define NINAB222_CMD_UDSF                  "UDSF"
#define NINAB222_CMD_UDUV                  "UDUV"
#define NINAB222_CMD_UDWS                  "UDWS"
#define NINAB222_CMD_UUDATA                "UUDATA"
#define NINAB222_CMD_UUDPC                 "UUDPC"
#define NINAB222_CMD_UUDPD                 "UUDPD"
   
#define NINAB222_CMD_UBTDM                 "UBTDM"
#define NINAB222_CMD_UBTCM                 "UBTCM"
#define NINAB222_CMD_UBTPM                 "UBTPM"
#define NINAB222_CMD_UBTSM                 "UBTSM"
#define NINAB222_CMD_UBTST                 "UBTST"
#define NINAB222_CMD_UBTUC                 "UBTUC"
#define NINAB222_CMD_UBTUPE                "UBTUPE"
#define NINAB222_CMD_UBTOTK                "UBTOTK"
#define NINAB222_CMD_UBTND                 "UBTND"
#define NINAB222_CMD_UBTI                  "UBTI"
#define NINAB222_CMD_UBTD                  "UBTD"
#define NINAB222_CMD_UBTBD                 "UBTBD"
#define NINAB222_CMD_UBTB                  "UBTB"
#define NINAB222_CMD_UBTUB                 "UBTUB"
#define NINAB222_CMD_UBTLN                 "UBTLN"
#define NINAB222_CMD_UBTLC                 "UBTLC"
#define NINAB222_CMD_UBTMSR                "UBTMSR"
#define NINAB222_CMD_UBTMSP                "UBTMSP"
#define NINAB222_CMD_UBTRSS                "UBTRSS"
#define NINAB222_CMD_UBTLQ                 "UBTLQ"
#define NINAB222_CMD_UBTLE                 "UBTLE"
#define NINAB222_CMD_UBTAD                 "UBTAD"
#define NINAB222_CMD_UBTSS                 "UBTSS"
#define NINAB222_CMD_UBTWS                 "UBTWS"
#define NINAB222_CMD_UBTCFG                "UBTCFG"
#define NINAB222_CMD_UBTLECFG              "UBTLECFG"
#define NINAB222_CMD_UBTDIR                "UBTDIR"
#define NINAB222_CMD_UBTACLC               "UBTACLC"
#define NINAB222_CMD_UBTACLD               "UBTACLD"
#define NINAB222_CMD_UBTLK                 "UBTLK"

#define NINAB222_PREFIX_SYMBOL_END         "\r\n"
#define NINAB222_PREFIX_SYMBOL_QUERY       "?"
#define NINAB222_PREFIX_SYMBOL_SET_VAL     "="
#define NINAB222_PREFIX_SYMBOL_PLUS        "+"
#define NINAB222_PREFIX_SYMBOL_AND         "&"
#define NINAB222_PREFIX_SYMBOL_SEPARATOR   ","
#define NINAB222_PREFIX_SYMBOL_SPACE       " "
#define NINAB222_PREFIX_SYMBOL_PERCENT     "%"
#define NINAB222_PREFIX_SYMBOL_NULL        ""
#define NINAB222_PREFIX_SYMBOL_QUOTE       "\""
#define NINAB222_PREFIX_SYMBOL_SPS         "sps://"
#define NINAB222_PREFIX_SYMBOL_ZERO        "0"
#define NINAB222_PREFIX_SYMBOL_ONE         "1"
#define NINAB222_PREFIX_SYMBOL_TWO         "2"

#define NINAB222_RSP_OK                    "OK"
#define NINAB222_RSP_ERROR                 "ERROR"

#define NINAB222_ECHO_OFF                  0
#define NINAB222_ECHO_ON                   1

#define NINAB222_MODE_COMMAND              0
#define NINAB222_MODE_DATA                 1
#define NINAB222_MODE_EXT_DATA             2
#define NINAB222_MODE_PPP                  3

#define NINAB222_GAP_MODE_NON_PAIRING      0
#define NINAB222_GAP_MODE_PAIRING          1

#define NINAB222_LR_ROLE_DISABLE           0
#define NINAB222_LR_ROLE_CENTRAL           1
#define NINAB222_LR_ROLE_PERIPHERAL        2
#define NINAB222_LR_ROLE_SIMULTANEOUS      3

#define NINAB222_GAP_MODE_NON_CONN         1
#define NINAB222_GAP_MODE_CONN             2

#define NINAB222_GAP_MODE_NON_DIS          1
#define NINAB222_GAP_MODE_LIM_DIS          2
#define NINAB222_GAP_MODE_GEN_DISC         3

#define NINAB222_ASCII_TABLE_START_NUM     48

#define NINAB222_PIN_STATE_LOW             0
#define NINAB222_PIN_STATE_HIGH            1

#define NINAB222_TX_DRV_BUFFER_SIZE        100
#define NINAB222_RX_DRV_BUFFER_SIZE        300
 // ninab222_cmd



#define NINAB222_MAP_MIKROBUS( cfg, mikrobus )      \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.sry = MIKROBUS( mikrobus, MIKROBUS_AN );    \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );   \
    cfg.cs  = MIKROBUS( mikrobus, MIKROBUS_CS );    \
    cfg.io5 = MIKROBUS( mikrobus, MIKROBUS_PWM );   \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 // ninab222_map // ninab222

typedef struct
{
    // Output pins
    digital_out_t rst;    
    digital_out_t cs;     
    digital_out_t io5;    
    digital_out_t sry;     
 
    // Input pins
    digital_in_t rts;     
 
    // Modules
    uart_t uart;          
 
    // Buffers
    uint8_t uart_rx_buffer[ NINAB222_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ NINAB222_TX_DRV_BUFFER_SIZE ];  
 
} ninab222_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
 
    // Additional gpio pins
    pin_name_t sry;    
    pin_name_t rst;    
    pin_name_t cs;     
    pin_name_t io5;    
    pin_name_t rts;    
 
    // Static variable
    uint32_t         baud_rate;                 
    bool             uart_blocking;             
    uart_data_bits_t data_bit;                  
    uart_parity_t    parity_bit;                
    uart_stop_bits_t stop_bit;                  
 
} ninab222_cfg_t;

typedef enum
{
    NINAB222_OK = 0,
    NINAB222_ERROR = -1
 
} ninab222_return_value_t;


void ninab222_cfg_setup ( ninab222_cfg_t *cfg );

err_t ninab222_init ( ninab222_t *ctx, ninab222_cfg_t *cfg );

err_t ninab222_generic_write ( ninab222_t *ctx, uint8_t *data_in, uint16_t len );

err_t ninab222_generic_read ( ninab222_t *ctx, uint8_t *data_out, uint16_t len );

void ninab222_hw_reset ( ninab222_t *ctx );

err_t ninab222_write_cmd ( ninab222_t *ctx, uint8_t *command );

err_t ninab222_write_sys_cmd ( ninab222_t *ctx, uint8_t *command );

err_t ninab222_write_cmd_param ( ninab222_t *ctx, uint8_t *command, uint8_t *param );

err_t ninab222_inquire_cmd ( ninab222_t *ctx, uint8_t *command );

err_t ninab222_rst_def_cfg ( ninab222_t *ctx );

err_t ninab222_reboot_dce ( ninab222_t *ctx );

err_t ninab222_set_bt_intf ( ninab222_t *ctx );

err_t ninab222_set_start_mode ( ninab222_t *ctx, uint8_t start_mode );

err_t ninab222_get_start_mode ( ninab222_t *ctx );

err_t ninab222_set_enter_mode ( ninab222_t *ctx, uint8_t enter_mode );

err_t ninab222_set_echo ( ninab222_t *ctx, uint8_t echo_en );

err_t ninab222_set_device_name ( ninab222_t *ctx, uint8_t *device_name );

err_t ninab222_get_device_name ( ninab222_t *ctx );

err_t ninab222_set_le_role ( ninab222_t *ctx, uint8_t le_role );

err_t ninab222_get_le_role ( ninab222_t *ctx );

err_t ninab222_get_peers_list ( ninab222_t *ctx );

err_t ninab222_set_default_cfg ( ninab222_t *ctx );

err_t ninab222_set_pairing_mode ( ninab222_t *ctx, uint8_t p_mode );

err_t ninab222_set_connectability ( ninab222_t *ctx, uint8_t c_mode );

err_t ninab222_get_connectability ( ninab222_t *ctx );

err_t ninab222_set_discoverability ( ninab222_t *ctx, uint8_t d_mode );

err_t ninab222_get_discoverability ( ninab222_t *ctx );

err_t ninab222_get_info ( ninab222_t *ctx );

err_t ninab222_remote_peer ( ninab222_t *ctx, uint8_t *domain );

err_t ninab222_periph_pairing_cfg ( ninab222_t *ctx );

void ninab222_clear_to_send ( ninab222_t *ctx, uint8_t cts );

uint8_t ninab222_request_to_send ( ninab222_t *ctx );

void ninab222_set_sry_pin ( ninab222_t *ctx, uint8_t state );

void ninab222_set_io5_pin ( ninab222_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif // NINAB222_H
 // ninab222
 
// ------------------------------------------------------------------------ END